com.inscoper.nbo.MicroscopeTube

Represents the XML element MicroscopeTube. More...

Inherits from com.inscoper.nbo.OpticalAssembly_Type, com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	MicroscopeTube()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setType(MicroscopeTubeType_Type value) Sets the value of the Type attribute.
MicroscopeTubeType_Type	getType() Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
boolean	hasType() Checks whether the optional Type attribute is present.
void	setMechanicalLength(float value) Sets the value of the MechanicalLength attribute.
float	getMechanicalLength() Returns the value of the MechanicalLength attribute.
void	resetMechanicalLength() Resets the MechanicalLength attribute to an unset state.
boolean	hasMechanicalLength() Checks whether the optional MechanicalLength attribute is present.
void	setMechanicalLengthUnit(UnitsLength_Type value) Sets the value of the MechanicalLengthUnit attribute.
UnitsLength_Type	getMechanicalLengthUnit() Returns the value of the MechanicalLengthUnit attribute.
void	resetMechanicalLengthUnit() Resets the MechanicalLengthUnit attribute to an unset state.
boolean	hasMechanicalLengthUnit() Checks whether the optional MechanicalLengthUnit attribute is present.
void	setOpticalLength(float value) Sets the value of the OpticalLength attribute.
float	getOpticalLength() Returns the value of the OpticalLength attribute.
void	resetOpticalLength() Resets the OpticalLength attribute to an unset state.
boolean	hasOpticalLength() Checks whether the optional OpticalLength attribute is present.
void	setOpticalLengthUnit(UnitsLength_Type value) Sets the value of the OpticalLengthUnit attribute.
UnitsLength_Type	getOpticalLengthUnit() Returns the value of the OpticalLengthUnit attribute.
void	resetOpticalLengthUnit() Resets the OpticalLengthUnit attribute to an unset state.
boolean	hasOpticalLengthUnit() Checks whether the optional OpticalLengthUnit attribute is present.
void	setFactor(float value) Sets the value of the Factor attribute.
float	getFactor() Returns the value of the Factor attribute.
void	resetFactor() Resets the Factor attribute to an unset state.
boolean	hasFactor() Checks whether the optional Factor attribute is present.
MicroscopeTube	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	MicroscopeTube(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(MicroscopeTube obj)

Additional inherited members

Public Functions inherited from com.inscoper.nbo.OpticalAssembly_Type

	Name
	OpticalAssembly_Type()
void	setID(LSID_Type value) Sets the value of the ID attribute.
LSID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setFilterRef_List(FilterRef_TypeVector value) Sets the list of FilterRef elements.
FilterRef_TypeVector	getFilterRef_List() Returns the list of FilterRef elements.
void	addToFilterRef_List(FilterRef_Type value) Adds a new FilterRef element to this object.
void	clearFilterRef_List() Clear the list of FilterRef.
void	setLensRef_List(LensRefVector value) Sets the list of LensRef elements.
LensRefVector	getLensRef_List() Returns the list of LensRef elements.
void	addToLensRef_List(LensRef value) Adds a new LensRef element to this object.
void	clearLensRef_List() Clear the list of LensRef.
void	setMirroringDeviceRef_List(MirroringDeviceRefVector value) Sets the list of MirroringDeviceRef elements.
MirroringDeviceRefVector	getMirroringDeviceRef_List() Returns the list of MirroringDeviceRef elements.
void	addToMirroringDeviceRef_List(MirroringDeviceRef value) Adds a new MirroringDeviceRef element to this object.
void	clearMirroringDeviceRef_List() Clear the list of MirroringDeviceRef.
void	setApertureRef_List(ApertureRefVector value) Sets the list of ApertureRef elements.
ApertureRefVector	getApertureRef_List() Returns the list of ApertureRef elements.
void	addToApertureRef_List(ApertureRef value) Adds a new ApertureRef element to this object.
void	clearApertureRef_List() Clear the list of ApertureRef.
void	setPolarizationOpticsRef_List(PolarizationOpticsRefVector value) Sets the list of PolarizationOpticsRef elements.
PolarizationOpticsRefVector	getPolarizationOpticsRef_List() Returns the list of PolarizationOpticsRef elements.
void	addToPolarizationOpticsRef_List(PolarizationOpticsRef value) Adds a new PolarizationOpticsRef element to this object.
void	clearPolarizationOpticsRef_List() Clear the list of PolarizationOpticsRef.
void	setPrismRef_List(PrismRefVector value) Sets the list of PrismRef elements.
PrismRefVector	getPrismRef_List() Returns the list of PrismRef elements.
void	addToPrismRef_List(PrismRef value) Adds a new PrismRef element to this object.
void	clearPrismRef_List() Clear the list of PrismRef.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.

Protected Functions inherited from com.inscoper.nbo.OpticalAssembly_Type

	Name
	OpticalAssembly_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the optional LotNumber attribute is present.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.MicroscopeTube;

Represents the XML element MicroscopeTube.

Illumination Tubes are Lens systems, which might be embedded within the Microscope Stand and therefore not immediately accessible. They are essential for infinity-correction and should be regarded as integral parts of the Objective Lens System when magnification and correction are considered.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.delete

function MicroscopeTube

public MicroscopeTube()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.fromJsonFile

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.fromJsonString

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.fromXmlFile

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.fromXmlString

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.toXmlFile

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.toXmlString

function setType

public void setType(
    MicroscopeTubeType_Type value
)

Sets the value of the Type attribute.

Parameters:

value The value to set

This field captures the category of this Tube.

function getType

public MicroscopeTubeType_Type getType()

Returns the value of the Type attribute.

Return: The value of the attribute

This field captures the category of this Tube.

function resetType

public void resetType()

Resets the Type attribute to an unset state.

This field captures the category of this Tube.

function hasType

public boolean hasType()

Checks whether the optional Type attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field captures the category of this Tube.

function setMechanicalLength

public void setMechanicalLength(
    float value
)

Sets the value of the MechanicalLength attribute.

Parameters:

value The value to set

For Objectives corrected for a finite primary Image distance, this is the length of the Tube in its simplest form, and it corresponds to the distance in air between the Objective and the Camera port. It commonly has a value of 160 mm (ISO 9345-1). For infinity-corrected objectives, the mechanical tube length is hypothetically considered to be infinite.

function getMechanicalLength

public float getMechanicalLength()

Returns the value of the MechanicalLength attribute.

Return: The value of the attribute

For Objectives corrected for a finite primary Image distance, this is the length of the Tube in its simplest form, and it corresponds to the distance in air between the Objective and the Camera port. It commonly has a value of 160 mm (ISO 9345-1). For infinity-corrected objectives, the mechanical tube length is hypothetically considered to be infinite.

function resetMechanicalLength

public void resetMechanicalLength()

Resets the MechanicalLength attribute to an unset state.

For Objectives corrected for a finite primary Image distance, this is the length of the Tube in its simplest form, and it corresponds to the distance in air between the Objective and the Camera port. It commonly has a value of 160 mm (ISO 9345-1). For infinity-corrected objectives, the mechanical tube length is hypothetically considered to be infinite.

function hasMechanicalLength

public boolean hasMechanicalLength()

Checks whether the optional MechanicalLength attribute is present.

Return: true if the optional attribute has been set, false otherwise

For Objectives corrected for a finite primary Image distance, this is the length of the Tube in its simplest form, and it corresponds to the distance in air between the Objective and the Camera port. It commonly has a value of 160 mm (ISO 9345-1). For infinity-corrected objectives, the mechanical tube length is hypothetically considered to be infinite.

function setMechanicalLengthUnit

public void setMechanicalLengthUnit(
    UnitsLength_Type value
)

Sets the value of the MechanicalLengthUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getMechanicalLengthUnit

public UnitsLength_Type getMechanicalLengthUnit()

Returns the value of the MechanicalLengthUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMechanicalLengthUnit

public void resetMechanicalLengthUnit()

Resets the MechanicalLengthUnit attribute to an unset state.

No description available in the XSD standard.

function hasMechanicalLengthUnit

public boolean hasMechanicalLengthUnit()

Checks whether the optional MechanicalLengthUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setOpticalLength

public void setOpticalLength(
    float value
)

Sets the value of the OpticalLength attribute.

Parameters:

value The value to set

This is the distance between the back focal Plane of the Objective and the primary Image Plane. This distance is relevant only when using finite primary Image distance Objectives.

function getOpticalLength

public float getOpticalLength()

Returns the value of the OpticalLength attribute.

Return: The value of the attribute

This is the distance between the back focal Plane of the Objective and the primary Image Plane. This distance is relevant only when using finite primary Image distance Objectives.

function resetOpticalLength

public void resetOpticalLength()

Resets the OpticalLength attribute to an unset state.

This is the distance between the back focal Plane of the Objective and the primary Image Plane. This distance is relevant only when using finite primary Image distance Objectives.

function hasOpticalLength

public boolean hasOpticalLength()

Checks whether the optional OpticalLength attribute is present.

Return: true if the optional attribute has been set, false otherwise

This is the distance between the back focal Plane of the Objective and the primary Image Plane. This distance is relevant only when using finite primary Image distance Objectives.

function setOpticalLengthUnit

public void setOpticalLengthUnit(
    UnitsLength_Type value
)

Sets the value of the OpticalLengthUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getOpticalLengthUnit

public UnitsLength_Type getOpticalLengthUnit()

Returns the value of the OpticalLengthUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetOpticalLengthUnit

public void resetOpticalLengthUnit()

Resets the OpticalLengthUnit attribute to an unset state.

No description available in the XSD standard.

function hasOpticalLengthUnit

public boolean hasOpticalLengthUnit()

Checks whether the optional OpticalLengthUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setFactor

public void setFactor(
    float value
)

Sets the value of the Factor attribute.

Parameters:

value The value to set

Factor (q) by which the lateral Magnification at the primary Image is changed by an intermediate Lens or Lens System inserted between the Objective and the primary Image.

function getFactor

public float getFactor()

Returns the value of the Factor attribute.

Return: The value of the attribute

Factor (q) by which the lateral Magnification at the primary Image is changed by an intermediate Lens or Lens System inserted between the Objective and the primary Image.

function resetFactor

public void resetFactor()

Resets the Factor attribute to an unset state.

Factor (q) by which the lateral Magnification at the primary Image is changed by an intermediate Lens or Lens System inserted between the Objective and the primary Image.

function hasFactor

public boolean hasFactor()

Checks whether the optional Factor attribute is present.

Return: true if the optional attribute has been set, false otherwise

Factor (q) by which the lateral Magnification at the primary Image is changed by an intermediate Lens or Lens System inserted between the Objective and the primary Image.

function __internal_create

public static MicroscopeTube __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.__internal_create

Protected Functions Documentation

function MicroscopeTube

protected MicroscopeTube(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.OpticalAssembly_Type.finalize

function getCPtr

protected static long getCPtr(
    MicroscopeTube obj
)

Updated on 2026-02-13 at 16:11:04 +0100